home *** CD-ROM | disk | FTP | other *** search
/ Risc World 3 / Risc World 3.iso / SOFTWARE / ISSUE4 / ZAP / !Zap / Modules / !Texture / !Help next >
Text File  |  2002-05-08  |  5KB  |  137 lines
  1.  
  2.                        !Help file for ZapTexture
  3.                        =========================
  4.  
  5. 1.0 : Features;
  6. 2.0 : Installation;
  7. 3.0 : What it does;
  8. 4.0 : More details;
  9. 5.0 : History;
  10. 6.0 : Contact.
  11.  
  12. 1.0 Features
  13. ~~~~~~~~~~~~
  14. True syntax colouring for Texture Garden files and support for textures from
  15. Studio24Pro and PhotoDesk 2.
  16.  
  17. Command completion and bracket matching have now been implemented.
  18.  
  19. Command completion is activated as normal by typing in the first part
  20. of a command and then pressing the full-stop key (".").
  21.  
  22. There is "Beautify" option which forces the displayed case of recognised
  23. commands to a pattern that enhances the readability of texture files.
  24.  
  25. Cursor key enhancements stolen from Martin Ebourne's modes (see later).
  26.  
  27. If you have a copy of Studio24Pro then this module works with textures from
  28. that program as well.  It keeps its textures in a "Textures" directory too.
  29. The "Beautify" option is useful for Studio24Pro texture files.  Textures
  30. from PhotoDesk are also offered similar support.
  31.  
  32.  
  33. 2.0 Installation
  34. ~~~~~~~~~~~~~~~~
  35. Copy the !Texture application directory inside !Zap.Modules, then restart Zap.
  36.  
  37. 3.0 What it does
  38. ~~~~~~~~~~~~~~~~
  39. When the module does not know about a command it colours it differently from
  40. normal commands to indicate that it has not been recognised.  This enables
  41. the module to be used as a spell-checker and, to a limited extent, a syntax
  42. checker.  The rule, as with most zap modes, is that if it is coloured
  43. incorrectly, then it needs examining.  If it is coloured it as though it is
  44. right, this does not mean it will actually work.
  45.  
  46. Command completion has now been implemented.  Note that the full-stop
  47. abbreviations used by ZapTexture and those implemented by Texture Garden
  48. are not guaranteed to be the same.  E.g. "o." might expand to something
  49. different in ZapTexture than what it would be treated as if it was fed
  50. as an abbreviation directly to Texture Garden.  Users are now unlikely
  51. to be using both methods, so this is unlikely to be a problem.
  52.  
  53. ZapTexture should have the more sensible abbreviations.
  54.  
  55. The module also contains some enhancements to the cursor keys so that when
  56. they are  used in combination with the shift key they behave in a more
  57. appropriate manner than when Zap is in text mode.  These routines have been
  58. stolen from Martin Ebourne's C mode and are documented by him in his own
  59. directory inside Zap.  Basically they make the shift-cursor combinations
  60. pause more frequently so they step more intelligently through lines with few
  61. spaces.  Martin has kindly given me his permission to use his code.
  62.  
  63. Those familiar with my other Zap modes may be wondering where the
  64. equivalent to their BEAUTIFY command is.  As Texture Garden provides much of
  65. the functionality of this command in its export text options, it has been
  66. stripped out of the Zap mode to save space.  The Beautify menu option
  67. remains, however, and those pining for the BEAUTIFY command will find that
  68. setting a very large width, and then pressing SHIFT-CTRL-COPY (in the
  69. default Zap keymap) can be used to produce a similar effect.
  70.  
  71.  
  72. 4.0 More details
  73. ~~~~~~~~~~~~~~~~
  74. The version number of ZapTexture should approximately track that of
  75. Texture Garden, as it is updated as Texture Garden's texture generation
  76. language expands.
  77.  
  78. For technical details on the module, users are referred to the documentation
  79. to ZapObey which has a very similar internal structure.  This should be
  80. available from my web site if you can't find it anywhere else.
  81.  
  82. Unlike another of my modes, ZapHoTMeaL, the command completion is not yet
  83. context sensitive.  For more details of the command completion routines,
  84. and details of how to configure the bracket matching delay, readers are
  85. currently referred to the documentation of versions of ZapHoTMeaL greater
  86. than version 0.51.
  87.  
  88.  
  89. 5.0 History
  90. ~~~~~~~~~~~
  91. This history does not cover ZapTexture's early developmental days.
  92.  
  93. v1.15 - (12-Dec-01)
  94.       * Internationalised directory structure
  95.  
  96. v1.13b- (25-Feb-97)
  97.       * Bugfixes associated with the new configuration code.
  98.  
  99. v1.13a- (25-Feb-97)
  100.       * Buttons support added.
  101.       * New configuration code installed.
  102.  
  103. v1.13 - (25-Feb-97)
  104.       * Cured bug introduced in v1.12 involving editing the first line of a
  105.         file crashing RPCs.
  106.       * Command completion no longer operates in comments.
  107.  
  108. v1.12 - (08-Feb-97)
  109.       * Cured problem involving lines wrapping around the edges of the
  110.         Zap window being coloured incorrectly;
  111.       * Improved command completion routines in line with recent changes in
  112.         ZapHoTMeaL;
  113.       * Command completion now works on the first line of text in the mode.
  114.       * The 'Beautify' menu option is now properly tickable.
  115.  
  116. v1.11 - (24-Jan-97)
  117.       * Command completion routines added;
  118.       * Bracket matching implemented.
  119.  
  120.  
  121. 6.0 Contact
  122. ~~~~~~~~~~~
  123.  
  124.   Bug reports should be sent to 
  125.  
  126.         bugs@zap.tartarus.org
  127.  
  128.   Feature requests should be directed towards
  129.  
  130.         zap-features@zap.tartarus.org
  131.  
  132.  
  133. There are a also a number of mailing lists you can subscribe to - see
  134. Zap's web pages for details:
  135.  
  136.         http://zap.tartarus.org/
  137.